FoxitPDFSDKPython2.PDF2MdSettingData Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions
def	PDF2MdSettingData ()
	Constructor. More...
def	Set (table_format, include_header_footer, enable_italic, enable_bold, skip_ocr_pages)
	Set value. More...

Static Public Attributes
	e_TableFormatHTML = _fsdk.PDF2MdSettingData_e_TableFormatHTML
	Table format: HTML table tags.
	e_TableFormatMarkdown = _fsdk.PDF2MdSettingData_e_TableFormatMarkdown
	Table format: Markdown pipe syntax (default).
	enable_bold = _fsdk.PDF2MdSettingData_enable_bold
	Whether to preserve bold formatting from the original PDF. Default: false. More...
	enable_italic = _fsdk.PDF2MdSettingData_enable_italic
	Whether to preserve italic formatting from the original PDF. Default: true. More...
	include_header_footer = _fsdk.PDF2MdSettingData_include_header_footer
	Whether to include page header/footer (artifact) content. Default: false. More...
	skip_ocr_pages = _fsdk.PDF2MdSettingData_skip_ocr_pages
	Whether to silently skip pages that contain only path/image objects. Default: false. More...
	table_format = _fsdk.PDF2MdSettingData_table_format
	Table output format. Default value: . More...

Detailed Description

This class represents setting data used for converting PDF documents to Markdown format.

Constructor & Destructor Documentation

PDF2MdSettingData()

def FoxitPDFSDKPython2.PDF2MdSettingData.PDF2MdSettingData

(

)

Constructor.

Constructor, with parameters.

Parameters

[in]	table_format	Table output format. Default: .
[in]	include_header_footer	Whether to include page header/footer content. Default: false.
[in]	enable_italic	Whether to apply italic markers in output. Default: true.
[in]	enable_bold	Whether to apply bold markers in output. Default: false.
[in]	skip_ocr_pages	Whether to silently skip scan-only pages. Default: false.

Member Function Documentation

Set()

def FoxitPDFSDKPython2.PDF2MdSettingData.Set	(		table_format,
			include_header_footer,
			enable_italic,
			enable_bold,
			skip_ocr_pages
	)

Set value.

Parameters

[in]	table_format	Table output format.
[in]	include_header_footer	Whether to include page header/footer content.
[in]	enable_italic	Whether to apply italic markers in output.
[in]	enable_bold	Whether to apply bold markers in output.
[in]	skip_ocr_pages	Whether to silently skip scan-only pages.

Returns

None.

Member Data Documentation

enable_bold

FoxitPDFSDKPython2.PDF2MdSettingData.enable_bold = _fsdk.PDF2MdSettingData_enable_bold

static

Whether to preserve bold formatting from the original PDF. Default: false.

When true, text that is bold in the PDF will have bold markers in output. When false, bold formatting is stripped.

enable_italic

FoxitPDFSDKPython2.PDF2MdSettingData.enable_italic = _fsdk.PDF2MdSettingData_enable_italic

static

Whether to preserve italic formatting from the original PDF. Default: true.

When true, text that is italic in the PDF will have italic markers in output. When false, italic formatting is stripped.

include_header_footer

FoxitPDFSDKPython2.PDF2MdSettingData.include_header_footer = _fsdk.PDF2MdSettingData_include_header_footer

static

Whether to include page header/footer (artifact) content. Default: false.

true means to include header/footer text in the output Markdown. false means to skip header/footer text.

skip_ocr_pages

FoxitPDFSDKPython2.PDF2MdSettingData.skip_ocr_pages = _fsdk.PDF2MdSettingData_skip_ocr_pages

static

Whether to silently skip pages that contain only path/image objects. Default: false.

When false, such scan-only pages cause an error to be thrown. When true, such pages are skipped and conversion continues.

table_format

FoxitPDFSDKPython2.PDF2MdSettingData.table_format = _fsdk.PDF2MdSettingData_table_format

static

Table output format. Default value: .

Please refer to values starting from FoxitPDFSDKPython2.PDF2MdSettingData.e_TableFormatMarkdown and this should be one of these values.